Skip to content

docs: improve lark-doc skill guidance#1283

Merged
fangshuyu-768 merged 3 commits into
mainfrom
codex/optimize-lark-doc-skill
Jun 8, 2026
Merged

docs: improve lark-doc skill guidance#1283
fangshuyu-768 merged 3 commits into
mainfrom
codex/optimize-lark-doc-skill

Conversation

@fangshuyu-768

@fangshuyu-768 fangshuyu-768 commented Jun 5, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Summary

  • shorten the lark-doc skill description while preserving the necessary doubao /docx|/wiki routing signals, and add explicit out-of-scope boundaries for comments and sheet/base data operations
  • add a default identity note for document operations so user-scoped access is clearer before readers enter the detailed workflow sections
  • add a scoped CRITICAL v2 reminder for docs +create, docs +fetch, and docs +update, plus a dedicated out-of-scope section for routing document comments, spreadsheet/base data work, whiteboard editing, and generic Drive file management to the right skills

Context

This updates the lark-doc business-domain skill based on the referenced review points, focusing on routing clarity, identity guidance, and keeping the skill concise enough for faster loading.

Testing

  • git diff --check
  • rough token count: 1910

Summary by CodeRabbit

  • Documentation
    • Clarified lark-doc scope: focus on Feishu Docx/Wiki reading/editing and route embedded resources by extracting tokens and using URL path patterns (not domain) for doubao /docx/ and /wiki/
    • Added auth requirement: run lark-cli auth login before first use; document operations default to --as user
    • Made v2 API mandatory: require --api-version v2 for docs +create, docs +fetch, and docs +update
    • Defined scope boundaries, delegating comments, spreadsheet/base ops, and cloud file permissions to other skills

@coderabbitai

coderabbitai Bot commented Jun 5, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 30ca4413-1b62-4950-8768-66c0f61b91d8

📥 Commits

Reviewing files that changed from the base of the PR and between 03ff8e9 and d1a1bf5.

📒 Files selected for processing (1)
  • skills/lark-doc/SKILL.md
💤 Files with no reviewable changes (1)
  • skills/lark-doc/SKILL.md
📝 Walkthrough

Walkthrough

Refocus lark-doc to Feishu Docx/Wiki read/edit, require token-first routing for embedded resources and --api-version v2 for docs commands, add default identity instructions (--as user, lark-cli auth login), and enumerate out-of-scope responsibilities delegated to other skills.

Changes

lark-doc Skill Scope and Responsibilities

Layer / File(s) Summary
Scope redefinition and identity instructions
skills/lark-doc/SKILL.md		 Simplified the top-level skill description to focus on Feishu Docx/Wiki read/edit and token-based routing for embedded resources. Added an Identity instruction specifying --as user default and requiring lark-cli auth login before first use. Updated v2 API callout to CRITICAL, requiring --api-version v2 on docs +create, docs +fetch, and docs +update.
Out-of-scope responsibilities enumeration
skills/lark-doc/SKILL.md		 Added a "不在本 Skill 范围" section enumerating delegated responsibilities: document comments and cloud file upload/download/permissions to lark-drive; spreadsheet/Base data ops to lark-sheets/lark-base.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • larksuite/cli#1082: Related changes to routing doubao.com document URLs using /docx/ and /wiki/ path patterns plus tokens.
  • larksuite/cli#890: Similar v2 requirement and token-based embedded-resource routing guidance updates in skills/lark-doc/SKILL.md.
  • larksuite/cli#1169: Documentation-only changes tightening cross-skill routing and auth/startup guidance.

Suggested reviewers

  • wittam-01

Poem

🐰 I hop through docs with nimble feet,
Tokens first, then content to meet.
Identity set, v2 in tune,
Responsibilities sent to their dune.
The rabbit nods — the README's neat.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: improve lark-doc skill guidance' is concise, clear, and directly related to the main change—improving documentation and guidance for the lark-doc skill.
Description check ✅ Passed The description covers the summary, changes, and context well. However, it lacks a structured 'Test Plan' section with the checklist format specified in the template, and 'Related Issues' is missing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/optimize-lark-doc-skill

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jun 5, 2026
@fangshuyu-768 fangshuyu-768 force-pushed the codex/optimize-lark-doc-skill branch from 8553932 to 1fb96fb Compare June 5, 2026 04:35
@github-actions

github-actions Bot commented Jun 5, 2026 •
edited
Loading

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@d1a1bf50de03b6f88699691503bead1576b33909

🧩 Skill update

npx skills add larksuite/cli#codex/optimize-lark-doc-skill -y -g

@fangshuyu-768 fangshuyu-768 force-pushed the codex/optimize-lark-doc-skill branch from 1fb96fb to 99229a1 Compare June 5, 2026 04:39
@codecov

codecov Bot commented Jun 5, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.47%. Comparing base (d0a896c) to head (d1a1bf5).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1283   +/-   ##
=======================================
  Coverage   71.47%   71.47%           
=======================================
  Files         688      688           
  Lines       65482    65482           
=======================================
  Hits        46806    46806           
  Misses      15031    15031           
  Partials     3645     3645

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@fangshuyu-768 fangshuyu-768 force-pushed the codex/optimize-lark-doc-skill branch from 99229a1 to a713b93 Compare June 8, 2026 11:31
@fangshuyu-768 fangshuyu-768 merged commit 8f5504c into main Jun 8, 2026
22 checks passed
@fangshuyu-768 fangshuyu-768 deleted the codex/optimize-lark-doc-skill branch June 8, 2026 12:02
SunPeiYang996 pushed a commit that referenced this pull request Jun 8, 2026
@fangshuyu-768 @SunPeiYang996
docs: improve lark-doc skill guidance (#1283)
db45fdd
@coderabbitai coderabbitai Bot mentioned this pull request Jun 9, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SunPeiYang996 SunPeiYang996 SunPeiYang996 approved these changes

Assignees

No one assigned

Labels

domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@fangshuyu-768 @SunPeiYang996